Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(feature-guide) Impact Analysis #5765

Merged
merged 26 commits into from
Sep 1, 2022

Conversation

maggiehays
Copy link
Collaborator

@maggiehays maggiehays commented Aug 29, 2022

This PR includes:

  • New feature guide for Impact Analysis
  • Template for Feature Guides
  • Improvements to docs-related READMEs

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions
Copy link

github-actions bot commented Aug 30, 2022

Unit Test Results (build & test)

517 tests  ±0   517 ✔️ ±0   8m 15s ⏱️ -9s
121 suites ±0       0 💤 ±0 
121 files   ±0       0 ±0 

Results for commit ab33a09. ± Comparison against base commit e884b69.

♻️ This comment has been updated with latest results.

docs/act-on-metadata/impact-analysis.md Outdated Show resolved Hide resolved
docs-website/generateDocsDir.ts Show resolved Hide resolved
docs-website/README.md Show resolved Hide resolved

### Feature Guide

A Feature Guide should follow the [Feature Guide Template](/_feature-guide-template.md), and should provide the following value:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jjoyce0510 looking for your input here

@maggiehays maggiehays added docs Issues and Improvements to docs product PR or Issue related to the DataHub UI/UX labels Aug 31, 2022

<FeatureAvailability/>

Impact Analysis is a powerful workflow for understanding the full set of upstream and downstream dependencies of a Dataset, Dashboard, Chart, and many other DataHub Entites.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit confusing -- is Impact Analysis a specific concept ? Or a feature?

To me we should just call this "Lineage" to avoid confusion. People will click "Lineage" to use the feature! Specific workflows can be a subset

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jjoyce0510 hmmm.. great question. We have a separate Lineage section under "Enrich Metadata", focused on the various ways you can ingest Lineage (Vineetha is on point to build out a better guide, basically building a guide off of our DataHub 101: Lineage video).

This one falls under the "Act on Metadata" section, so I think it still makes sense to call it Impact Analysis. I know we took that terminology out of the UI, but we continue to refer to it as the main lineage-related workflow. My preference would be to keep it as-is for now.

What do you think?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jjoyce0510 just saw @hsheth2's note about high search volume for the term Lineage. How about we meet in the middle & I rephrase it as Lineage Impact Analysis?

docs-website/README.md Outdated Show resolved Hide resolved
@maggiehays maggiehays merged commit 4956f5a into datahub-project:master Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and Improvements to docs product PR or Issue related to the DataHub UI/UX
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants